Skip to content

chore: clean-up#13373

Merged
kgryte merged 8 commits into
developfrom
philipp/fix-commit-review-2026-07-08
Jul 9, 2026
Merged

chore: clean-up#13373
kgryte merged 8 commits into
developfrom
philipp/fix-commit-review-2026-07-08

Conversation

@Planeshifter

@Planeshifter Planeshifter commented Jul 8, 2026

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request contains follow-up fixes for commits merged to develop between 2026-07-07 14:20 PDT (b5b7b4c) and 2026-07-08 01:31 PDT (bb93e56). Findings were surfaced by an automated multi-agent review of the window's union diff, then filtered to keep only high-signal, unambiguous defects (typos, broken doc identifiers, style-guide violations, and a demonstrable declarations gap).

Fixes, grouped by package:

  • Fix searchElement param docs mislabeled as "scalar constant"/"search Element" across blas/ext/base/dfill-equal (lib/dfill_equal.js, lib/dfill_equal.native.js, lib/ndarray.js, lib/ndarray.native.js, src/main.c, README.md), normalizing to "search element" to match docs/types/index.d.ts; copy-paste leftover from ad0783b.
  • In ml/base/sgd-classification/loss-functions (3148fe6), the C API docs in README.md reference STDLIB_ML_SGD_CLASSIFICATION_LOSS_FUNCTIONS/STDLIB_ML_SGD_CLASSIFICATION_HINGE, but the header declares STDLIB_ML_BASE_SGD_CLASSIFICATION_LOSS_FUNCTIONS/STDLIB_ML_BASE_SGD_CLASSIFICATION_HINGE (missing _BASE_), so the documented usage example doesn't compile; fixed to match include/stdlib/ml/base/sgd-classification/loss_functions.h. Also fixed a stray filename typo (loss functions.hloss_functions.h) in lib/enum.js and spacing (obj[ o[i] ]obj[ o[ i ] ]) in test/test.js to match house style.
  • Backfill cxmy, zxmy, and dfillEqual imports and interface members in lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts, mirroring the sibling cxpy/dfill/zxpy blocks; these three landed on the runtime namespace via 5402a8a but were never added to the declarations file, which 044b270 last touched for other packages.

Related Issues

Does this pull request have any related issues?

No.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Validation. The multi-agent review comprised: (1) two style-guide compliance passes (one over the new BLAS/ML packages, one over the docs / lint / refactor sweeps), each comparing every touched file against an established sibling of similar shape; (2) two independent bug hunts over the diff-only surface. Findings surviving cross-agent verification and diff re-check were kept; the rest were dropped as either subjective or out-of-scope.

Deliberately excluded from this PR:

  • Adding .0 decimal suffixes to the y0 REPL output in blas/ext/base/{cxmy,zxmy}/docs/repl.txt — initially applied for consistency with sibling cxpy/zxpy docs, then reverted because the resulting line exceeds the 80-character REPL line-length lint rule (the larger absolute values in the cxmy/zxmy example don't fit once suffixed). The original integer formatting was a deliberate choice by the package authors to satisfy the same rule.
  • An isnan-guard ordering inconsistency across the stats/base/dists refactor (b5b7b4c) — both orderings are functionally equivalent and the JS style guide does not prescribe one. Left to a follow-up if maintainers want to normalize.
  • Extending the 09d16f18 "returns → e.g., returns" wording fix into regexp/basename/README.md — the README example is guarded by an explicit "Assuming a POSIX platform..." comment and the original lint sweep did not touch READMEs.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

This PR was assembled by an automated Claude Code review routine. The routine enumerated commits merged to develop in the preceding 24 hours, fanned out to independent reviewer subagents (two for stdlib style-guide compliance, two for bug hunting), merged and filtered the findings to a high-signal set, applied the fixes grouped by package, and drafted this body. A maintainer should audit each commit before promoting from draft.


claude added 5 commits July 8, 2026 12:26
The `y0` output in the view-offset example was rendered without `.0` decimal suffixes, deviating from the convention used throughout the rest of the file and the sibling `cxpy` REPL docs.
The `y0` output in the view-offset example was rendered without `.0` decimal suffixes, deviating from the convention used throughout the rest of the file and the sibling `zxpy` REPL docs.
…ill-equal`

The `searchElement` JSDoc, C doc-comment, and README C API parameter descriptions all duplicated the wording used for `alpha` ("scalar constant") or capitalized "Element" mid-sentence. Aligns each with the correct "search element" description used in the `.d.ts` and the README's JavaScript API section.
…n/loss-functions`

The README's C API section referenced enum identifiers (`STDLIB_ML_SGD_CLASSIFICATION_*`) that do not exist in the header — the header declares `STDLIB_ML_BASE_SGD_CLASSIFICATION_LOSS_FUNCTIONS` — so the documented C usage example would not compile. Also corrects the `loss functions.h` filename typo in the JS enum comment and adds missing array-index spacing in the test.
…ipt declarations

Adds imports and interface members for the `cxmy`, `zxmy`, and `dfillEqual` packages, which are registered on the runtime namespace but were missing from the aggregate `.d.ts`.
@Planeshifter Planeshifter changed the title Follow-up fixes for commits merged 2026-07-07 → 2026-07-08 chore: follow-up fixes for recent develop commits Jul 8, 2026
@stdlib-bot

stdlib-bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/dfill-equal $\\color{green}363/363$
$\\color{green}+0.00\\%$
$\\color{green}18/18$
$\\color{green}+0.00\\%$
$\\color{green}4/4$
$\\color{green}+0.00\\%$
$\\color{green}363/363$
$\\color{green}+0.00\\%$
ml/base/sgd-classification/loss-functions $\\color{green}163/163$
$\\color{green}+0.00\\%$
$\\color{green}5/5$
$\\color{green}+0.00\\%$
$\\color{green}2/2$
$\\color{green}+0.00\\%$
$\\color{green}163/163$
$\\color{green}+0.00\\%$

The above coverage report was generated for the changes in this PR.

The `.0` decimal suffixes added in 86040fd and 5affd15 pushed the `y0` output past the 80-character REPL line-length lint rule (the values `-15/80/148/232` don't fit under 80 chars once suffixed, unlike the smaller values in the sibling `cxpy`/`zxpy` docs). Reverts to the integer formatting the original commits used.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Planeshifter These sorts of changes should not be considered "fixes". We have automated workflows for this. This sort of proposed change just adds noise. In short, tell your bot to stay in its lane.

@kgryte kgryte marked this pull request as ready for review July 8, 2026 23:41
@kgryte kgryte requested a review from a team July 8, 2026 23:41
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jul 8, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Jul 8, 2026
@kgryte kgryte changed the title chore: follow-up fixes for recent develop commits chore: clean-up Jul 9, 2026
@kgryte kgryte merged commit 9757a36 into develop Jul 9, 2026
50 checks passed
@kgryte kgryte deleted the philipp/fix-commit-review-2026-07-08 branch July 9, 2026 06:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants